org.eclipse.vtp.framework.core
Interface IExecutionContext

All Superinterfaces:

IContext, ILogger, IProcessContext, IReporter, ISessionContext

All Known Subinterfaces:

IActionContext

All Known Implementing Classes:

AbstractActionContext, AbstractExecutionContext, ActionContextWrapper, Execution.Context, ExecutionContextWrapper, Sequence.Context

public interface IExecutionContext
extends ISessionContext

A service available to all services at the execution or action scope.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.core.IReporter

SEVERITY_DEBUG, SEVERITY_ERROR, SEVERITY_INFO, SEVERITY_WARN

Method Summary

void	clearParameter(java.lang.String parameterName) Clears the value of the execution-level parameter with the specified name.
java.lang.String	getExecutionID() Returns the ID of this execution.
java.lang.String	getParameter(java.lang.String parameterName) Returns the value of the execution-level parameter with the specified name or null if no such parameter exists.
java.lang.String[]	getParameterNames() Returns the names of the parameters available to the execution sequence.
java.lang.String[]	getParameters(java.lang.String parameterName) Returns the values of the execution-level parameter with the specified name or null if no such parameter exists.
void	setParameter(java.lang.String parameterName, java.lang.String value) Sets the value of the execution-level parameter with the specified name or clears it if the value is null.
void	setParameters(java.lang.String parameterName, java.lang.String[] values) Sets the values of the execution-level parameter with the specified name or clears them if the value is null or empty.

Methods inherited from interface org.eclipse.vtp.framework.core.ISessionContext

clearAttribute, getAttribute, getAttributeNames, getSessionID, setAttribute

Methods inherited from interface org.eclipse.vtp.framework.core.IProcessContext

getProcessID, getProperty, loadClass

Methods inherited from interface org.eclipse.vtp.framework.core.IContext

lookup, lookupAll

Methods inherited from interface org.eclipse.vtp.framework.core.ILogger

debug, debug, debug, debug, error, error, error, error, info, info, info, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isWarnEnabled, log, log, log, log, warn, warn, warn, warn

Methods inherited from interface org.eclipse.vtp.framework.core.IReporter

isSeverityEnabled, report, report, report, report

Method Detail

getExecutionID

java.lang.String getExecutionID()

Returns the ID of this execution.

Returns:

The ID of this execution.

getParameterNames

java.lang.String[] getParameterNames()

Returns the names of the parameters available to the execution sequence.

Returns:

The names of the parameters available to the execution sequence.

getParameter

java.lang.String getParameter(java.lang.String parameterName)
                              throws java.lang.NullPointerException

Returns the value of the execution-level parameter with the specified name or null if no such parameter exists.

Parameters:

parameterName - The name of the parameter to return.

Returns:

The value of the execution-level parameter with the specified name or null if no such parameter exists.

Throws:

java.lang.NullPointerException - If the supplied parameter name is null.

getParameters

java.lang.String[] getParameters(java.lang.String parameterName)
                                 throws java.lang.NullPointerException

Returns the values of the execution-level parameter with the specified name or null if no such parameter exists.

Parameters:

parameterName - The name of the parameter to return.

Returns:

The values of the execution-level parameter with the specified name or null if no such parameter exists.

Throws:

java.lang.NullPointerException - If the supplied parameter name is null.

setParameter

void setParameter(java.lang.String parameterName,
                  java.lang.String value)
                  throws java.lang.NullPointerException

Sets the value of the execution-level parameter with the specified name or clears it if the value is null.

Parameters:

parameterName - The name of the parameter to set.

value - The value of the execution-level parameter with the specified name or null to clear the value.

Throws:

java.lang.NullPointerException - If the supplied parameter name is null.

setParameters

void setParameters(java.lang.String parameterName,
                   java.lang.String[] values)
                   throws java.lang.NullPointerException

Sets the values of the execution-level parameter with the specified name or clears them if the value is null or empty.

Parameters:

parameterName - The name of the parameters to set.

values - The values of the execution-level parameter with the specified name or null or to clear the values.

Throws:

java.lang.NullPointerException - If the supplied parameter name is null.

clearParameter

void clearParameter(java.lang.String parameterName)
                    throws java.lang.NullPointerException

Clears the value of the execution-level parameter with the specified name.

Parameters:

parameterName - The name of the parameter to clear.

Throws:

java.lang.NullPointerException - If the supplied parameter name is null.